home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / DOpus_SDK_5.5 / docs / gui.doc < prev    next >
Text File  |  1996-09-07  |  12KB  |  386 lines
  1. TABLE OF CONTENTS
  2.  
  3. dopus5.library/ActivateStrGad
  4. dopus5.library/AddScrollBars
  5. dopus5.library/BOOPSIFree
  6. dopus5.library/DisposeBitMap
  7. dopus5.library/DrawBox
  8. dopus5.library/DrawFieldBox
  9. dopus5.library/FindBOOPSIGadget
  10. dopus5.library/GetPalette32
  11. dopus5.library/LoadPalette32
  12. dopus5.library/NewBitMap
  13. dopus5.library/ScreenInfo
  14. dopus5.library/FindPubScreen
  15. dopus5.library/SetBusyPointer
  16. dopus5.library/ActivateStrGad                   dopus5.library/ActivateStrGad
  17.  
  18.     NAME
  19.         ActivateStrGad - Activate a string gadget.
  20.  
  21.     SYNOPSIS
  22.         ActivateStrGad(gadget, window)
  23.                          A0      A1
  24.  
  25.         void ActivateStrGad(struct Gadget *, struct Window *);
  26.  
  27.     FUNCTION
  28.         This function activates a string gadget in a window. The difference
  29.         between this and the standard ActivateGadget() call is that the
  30.         cursor will be positioned at the end of the string.
  31.  
  32.     INPUTS
  33.         gadget - string gadget you wish to activate
  34.         window - window the gadget is in
  35.  
  36.     SEE ALSO
  37.         intuition.library/ActivateGadget()
  38.  
  39. dopus5.library/AddScrollBars                     dopus5.library/AddScrollBars
  40.  
  41.     NAME
  42.         AddScrollBars - Add BOOPSI scrollers to a window
  43.  
  44.     SYNOPSIS
  45.         AddScrollBars(window, list, drawinfo, flags)
  46.                         A0     A1      A2       D0
  47.  
  48.         struct Gadget *AddScrollBars(struct Window *, struct List *,
  49.                                      struct DrawInfo *, short);
  50.  
  51.     FUNCTION
  52.         This function adds BOOPSI scrollers (proportional gadget and two
  53.         arrows) to a window. It can add scrollers either horizontally,
  54.         vertically or both.
  55.  
  56.     INPUTS
  57.         window - window to add scrollers to. The window must have a border
  58.         for the side(s) you wish to add scrollers to. For example, if you
  59.         add a horizontal scroller, the window must have a bottom border
  60.         (ie the WFLG_SIZEBBOTTOM flag is set).
  61.  
  62.         list - this must point to an initialise List structure. The
  63.         gadgets created by this routine will be added to this List, which
  64.         can later be freed by BOOPSIFree().
  65.  
  66.         drawinfo - pointer to the screen's DrawInfo structure
  67.  
  68.         flags - the type of scrollers you want :
  69.  
  70.                 SCROLL_VERT     - vertical scroller
  71.                 SCROLL_HORIZ    - horizontal scroller
  72.                 SCROLL_NOIDCMP  - this flag signified that the scrollers
  73.                                   are only to return the normal
  74.                                   IDCMP_GADGETUP, IDCMP_GADGETDOWN and
  75.                                   IDCMP_MOUSEMOVE messages. If not
  76.                                   specified, the gadgets also generate
  77.                                   IDCMP_IDCMPUPDATE messages.
  78.  
  79.     RESULT
  80.         This routine returns 0 if it fails. If it succeeds, it returns a
  81.         pointer to the last gadget created. This pointer is not particularly
  82.         useful; it just signifies success. To actually add the gadgets to the
  83.         window, call AddGList() on the first gadget in the supplied List
  84.         structure, and then RefreshGList().
  85.  
  86.         The gadgets created by this function have pre-defined IDs. If you
  87.         use this routine you should make sure that your own gadgets do not
  88.         conflict with these IDs. See the "dopus/gui.h" file for the ID values.
  89.  
  90.     SEE ALSO
  91.         FindBOOPSIGadget(), BOOPSIFree(),
  92.         intuition.library/GetScreenDrawInfo(), intuition.library/AddGList(),
  93.         intuition.library/RefreshGList()
  94.  
  95. dopus5.library/BOOPSIFree                           dopus5.library/BOOPSIFree
  96.  
  97.     NAME
  98.         BOOPSIFree - free a list of BOOPSI gadgets
  99.  
  100.     SYNOPSIS
  101.         BOOPSIFree(list)
  102.                     A0
  103.  
  104.         void BOOPSIFree(struct List *);
  105.  
  106.     FUNCTION
  107.         This routine iterates through a list of BOOPSI gadgets, calling
  108.         DisposeObject on each one in turn. It then reinitialises the list.
  109.  
  110.     INPUTS
  111.         list - List of gadgets to free
  112.  
  113.     SEE ALSO
  114.         AddScrollBars(), intuition.library/DisposeObject()
  115.  
  116. dopus5.library/DisposeBitMap                     dopus5.library/DisposeBitMap
  117.  
  118.     NAME
  119.         DisposeBitMap - free a bitmap created with NewBitMap()
  120.  
  121.     SYNOPSIS
  122.         DisposeBitMap(bm)
  123.                       A0
  124.  
  125.         void DisposeBitMap(struct BitMap *);
  126.  
  127.     FUNCTION
  128.         This routine frees a bitmap and the associated bitplanes that was
  129.         allocated with the NewBitMap() function. Under OS39 it simply passes
  130.         the bitmap through to the graphics.library FreeBitMap() call. Under
  131.         OS37 it frees the bitmap and bitplanes manually.
  132.  
  133.     INPUTS
  134.         bm - BitMap to free
  135.  
  136.     RESULT
  137.         The BitMap is freed.
  138.  
  139.     SEE ALSO
  140.         NewBitMap(), graphics.library/FreeBitMap()
  141.  
  142. dopus5.library/DrawBox                                 dopus5.library/DrawBox
  143.  
  144.     NAME
  145.         DrawBox - draw a 3D box
  146.  
  147.     SYNOPSIS
  148.         DrawBox(rp, rect, info, recessed)
  149.                 A0   A1    A2      D0
  150.  
  151.         void DrawBox(struct RastPort *, struct Rectangle *,
  152.                      struct DrawInfo *, BOOL);
  153.  
  154.     FUNCTION
  155.         This routine draws a single-pixel 3D box, using the current pen
  156.         settings in the DrawInfo you supply.
  157.  
  158.     INPUTS
  159.         rp - RastPort to draw into
  160.         rect - Rectangle to draw
  161.         info - Screen's DrawInfo
  162.         recessed - set to TRUE if you want a recessed box
  163.  
  164.     SEE ALSO
  165.         intuition.library/GetScreenDrawInfo()
  166.  
  167. dopus5.library/DrawFieldBox                        dopus5.library/DrawFieldBox
  168.  
  169.     NAME
  170.         DrawFieldBox - draw a 3D field box
  171.  
  172.     SYNOPSIS
  173.         DrawFieldBox(rp, rect, info)
  174.                      A0   A1    A2
  175.  
  176.         void DrawFieldBox(struct RastPort *, struct Rectangle *,
  177.                           struct DrawInfo *);
  178.  
  179.     FUNCTION
  180.         Draws a 3D field box (eg the path field in DOpus listers).
  181.  
  182.     INPUTS
  183.         rp - RastPort to draw into
  184.         rect - Rectangle to draw
  185.         info - Screen's DrawInfo
  186.  
  187.     SEE ALSO
  188.         intuition.library/GetScreenDrawInfo()
  189.  
  190. dopus5.library/FindBOOPSIGadget               dopus5.library/FindBOOPSIGadget
  191.  
  192.     NAME
  193.         FindBOOPSIGadget - find a gadget by ID in a BOOPSI list
  194.  
  195.     SYNOPSIS
  196.         FindBOOPSIGadget(list, id)
  197.                           A0   D0
  198.  
  199.         struct Gadget *FindBOOPSIGadget(struct List *, USHORT);
  200.  
  201.     FUNCTION
  202.         This routine iterates through the supplied list of gadgets looking
  203.         for one with the supplied ID. If found, it returns it.
  204.         This routine can be used to find a specific gadget in the List
  205.         created by AddScrollBars(). eg,
  206.  
  207.             vert_scroll=FindBOOPSIGadget(&list,GAD_VERT_SCROLLER);
  208.  
  209.     INPUTS
  210.         list - List of BOOPSI gadgets
  211.         id - ID to look for
  212.  
  213.     RESULT
  214.         If the gadget is found, it is returned, otherwise NULL.
  215.  
  216.     SEE ALSO
  217.         AddScrollBars()
  218.  
  219. dopus5.library/GetPalette32                       dopus5.library/GetPalette32
  220.  
  221.     NAME
  222.         GetPalette32 - get a 32 bit palette from a ViewPort
  223.  
  224.     SYNOPSIS
  225.         GetPalette32(vp, palette, count, first)
  226.                      A0    A1       D0     D1
  227.  
  228.         void GetPalette32(struct ViewPort *, ULONG, USHORT, short);
  229.  
  230.     FUNCTION
  231.         This routine copies the palette from the supplied ViewPort into
  232.         the supplied buffer. Under OS39 it is identical in operation to
  233.         the graphics.library GetRGB32() function. The advantage of using
  234.         this function is that it also works under OS37. Under OS37, the
  235.         4 bit colour values are extended to full 32 bit.
  236.  
  237.     INPUTS
  238.         vp - ViewPort to load colours from
  239.         palette - array of ULONGs to store palette (3 per pen)
  240.         count - number of pen values to copy
  241.         first - first pen to copy
  242.  
  243.     RESULT
  244.         The palette values are stored in the supplied array.
  245.  
  246.     SEE ALSO
  247.         LoadPalette32(), graphics.library/GetRGB32()
  248.  
  249. dopus5.library/LoadPalette32                     dopus5.library/LoadPalette32
  250.  
  251.     NAME
  252.         LoadPalette32 - load a 32 bit palette in a ViewPort
  253.  
  254.     SYNOPSIS
  255.         LoadPalette32(vp, palette)
  256.                       A0     A1
  257.  
  258.         void LoadPalette32(struct ViewPort *, ULONG *);
  259.  
  260.     FUNCTION
  261.         This routine loads a 32 bit palette into a ViewPort. It is
  262.         identical in operation to the graphics.library LoadRGB32()
  263.         function, except that it also works under OS37.
  264.  
  265.     INPUTS
  266.         vp - ViewPort to load palette
  267.         palette - Palette to load (in LoadRGB32() format)
  268.  
  269.     RESULT
  270.         The palette is loaded.
  271.  
  272.     SEE ALSO
  273.         GetPalette32, graphics.library/LoadRGB32()
  274.  
  275. dopus5.library/NewBitMap                             dopus5.library/NewBitMap
  276.  
  277.     NAME
  278.         NewBitMap - allocate a bitmap and bitplanes
  279.  
  280.     SYNOPSIS
  281.         NewBitMap(sizex, sizey, depth, flags, friend)
  282.                    D0      D1     D2     D3      A0
  283.  
  284.         struct BitMap *NewBitMap(ULONG, ULONG, ULONG, ULONG, struct BitMap *);
  285.  
  286.     FUNCTION
  287.         This routine allocates a BitMap and the bitplanes for it. It is
  288.         identical in operation to the graphics.library AllocBitMap() call,
  289.         except that it works under OS37. Under OS37 the bitmap and planes
  290.         are allocated manually, and the friend parameter is ignored.
  291.  
  292.         Under OS39, if a friend bitmap is supplied and that friend is not
  293.         a standard BitMap (ie BMF_STANDARD is not set), the new bitmap will
  294.         be allocated with the BMF_MINPLANES flag. This makes CyberGfx allocate
  295.         a fast chunky bitmap.
  296.  
  297.     INPUTS
  298.         sizex - width of bitmap
  299.         sizey - height of bitmap
  300.         depth - number of bitplanes
  301.         flags - bitmap flags
  302.         friend - friend bitmap
  303.  
  304.     RESULT
  305.         Returns the BitMap if successful, otherwise NULL.
  306.  
  307.     SEE ALSO
  308.         DisposeBitMap(), graphics.library/AllocBitMap()
  309.  
  310. dopus5.library/ScreenInfo                           dopus5.library/ScreenInfo
  311.  
  312.     NAME
  313.         ScreenInfo - return information about a screen
  314.  
  315.     SYNOPSIS
  316.         ScreenInfo(screen)
  317.                      A0
  318.  
  319.         ULONG ScreenInfo(struct Screen *);
  320.  
  321.     FUNCTION
  322.         This routine is designed to return simple information about a screen.
  323.  
  324.     INPUTS
  325.         screen - Screen to obtain information about.
  326.  
  327.     RESULT
  328.         Currently, the only flag defined for the result is SCRI_LORES, which
  329.         indicates that the screen is low resolution, or does not have a 1:1
  330.         pixel ratio.
  331.  
  332. dopus5.library/FindPubScreen                     dopus5.library/FindPubScreen
  333.  
  334.     NAME
  335.         FindPubScreen - find (and lock) a public screen
  336.  
  337.     SYNOPSIS
  338.         FindPubScreen(screen, lock)
  339.                         A0     D0
  340.  
  341.         struct PubScreenNode *FindPubScreen(struct Screen *, BOOL);
  342.  
  343.     FUNCTION
  344.         This function takes the address of a Screen, and searches for it in
  345.         the system Public Screen list. If it is found, the address of the
  346.         PubScreenNode is returned.
  347.  
  348.     INPUTS
  349.         screen - Screen to search for
  350.         lock - Set to TRUE if you want the screen to be locked on return
  351.  
  352.     RESULT
  353.         Returns the PubScreenNode of the screen if found, otherwise NULL.
  354.         If 'lock' is set to TRUE, the public screen will be locked for you
  355.         and you should call UnlockPubScreen() on it when you are finished.
  356.  
  357.     SEE ALSO
  358.         intuition.library/LockPubScreen()
  359.  
  360. dopus5.library/SetBusyPointer                   dopus5.library/SetBusyPointer
  361.  
  362.     NAME
  363.         SetBusyPointer - set busy pointer in a window
  364.  
  365.     SYNOPSIS
  366.         SetBusyPointer(window)
  367.                          A0
  368.  
  369.         void SetBusyPointer(struct Window *);
  370.  
  371.     FUNCTION
  372.         This function sets the mouse pointer in the supplied window to
  373.         the busy pointer. Under OS39 it uses the system-defined busy
  374.         pointer. Under OS37 it uses a standard watch image.
  375.  
  376.     INPUTS
  377.         window - Window to set busy pointer for
  378.  
  379.     RESULT
  380.         The busy pointer is set in the supplied window. You should call
  381.         ClearPointer() when you have finished.
  382.  
  383.     SEE ALSO
  384.         intuition.library/SetWindowPointer, intuition.library/ClearPointer
  385.  
  386.